Skip to main content

Ban Or Unban User

POST /admin/:username​

Description​

Toggles a user's banned status.

Request Parameters​

Requires Authentication: true​

Requires Admin Role: true​

PATH PARAMS​

NameTypeRequiredDescription
usernamestringYesUsername of the target user.

BODY​

NameTypeRequiredDescription
messagestringNoBan or unban reason.

Success Response​

{
"message": "johndoe banned successfully"
}

or

{
"message": "johndoe unbanned successfully"
}

Error Response​

CodeDescription
401Missing or invalid access token
402User is not an admin
403Unauthorized action
404User not found
413Reason too long
500Server error